home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / cat3 / SetClass.3 < prev    next >
Text File  |  1994-09-20  |  2KB  |  67 lines
  1.  
  2.  
  3.  
  4. Tk_SetClass(3)        Tk Library Procedures
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      Tk_SetClass, Tk_Class - set or retrieve a window's class
  12.  
  13. SYNOPSIS
  14.      #include <tk.h>
  15.  
  16.      Tk_SetClass(_t_k_w_i_n, _c_l_a_s_s)
  17.  
  18.      Tk_Uid
  19.      Tk_Class(_t_k_w_i_n)
  20.  
  21. ARGUMENTS
  22.      Tk_Window   _t_k_w_i_n    (in)      Token for window.
  23.  
  24.      char        *_c_l_a_s_s   (in)      New class name for window.
  25. _________________________________________________________________
  26.  
  27.  
  28. DESCRIPTION
  29.      Tk_SetClass is called to associate a class with a particular
  30.      window.  The _c_l_a_s_s string identifies the type of the window;
  31.      all windows with the same general class of behavior (button,
  32.      menu,  etc.)  should have the same class.  By convention all
  33.      class names start with a capital letter, and there exists  a
  34.      Tcl  command with the same name as each class (except all in
  35.      lower-case) which can be used to create and manipulate  win-
  36.      dows  of that class.  A window's class string is initialized
  37.      to NULL when the window is created.
  38.  
  39.      For main windows, Tk automatically propagates the  name  and
  40.      class  to  the  WM_CLASS  property  used by window managers.
  41.      This happens either when a main window is  actually  created
  42.      (e.g. in Tk_MakeWindowExist), or when Tk_SetClass is called,
  43.      whichever occurs later.  If  a  main  window  has  not  been
  44.      assigned  a class then Tk will not set the WM_CLASS property
  45.      for the window.
  46.  
  47.      Tk_Class is a  macro  that  returns  the  current  value  of
  48.      _t_k_w_i_n's class.  The value is returned as a Tk_Uid, which may
  49.      be used just like a string pointer but also has the  proper-
  50.      ties  of  a  unique  identfier  (see  the  manual  entry for
  51.      Tk_GetUid for details).  If _t_k_w_i_n has not yet been  given  a
  52.      class, then Tk_Class will return NULL.
  53.  
  54.  
  55. KEYWORDS
  56.      class, unique identifier, window, window manager
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.